-
-
Notifications
You must be signed in to change notification settings - Fork 8.6k
[py] Replaced :param: and :args: from docstrings #16469
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[py] Replaced :param: and :args: from docstrings #16469
Conversation
…nd options classes
… and RemoteConnection classes
PR Compliance Guide 🔍Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label |
@cgoldberg more files to review . thanks 🙏 |
PR Code Suggestions ✨Explore these optional code suggestions:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
User description
🔗 Related Issues
relates to #11442
💥 What does this PR do?
This pull request updates docstrings throughout the codebase to use the Google-style
Args
andReturns
format, replacing the previous:param
and:returns
syntax. The changes improve consistency and readability of documentation for classes and methods in several modules, includingcdp.py
,script.py
,driver_finder.py
,options.py
, andservice.py
.Docstring style modernization:
py/selenium/webdriver/common/bidi/cdp.py
to useArgs
andReturns
sections instead of:param
and:returns
, enhancing clarity for parameters and return values. [1] [2] [3] [4] [5] [6]py/selenium/webdriver/common/bidi/script.py
to use the new format, including constructors and JSON deserialization methods. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15]py/selenium/webdriver/common/driver_finder.py
to useArgs
.py/selenium/webdriver/common/options.py
, including consistent use ofArgs
andReturns
and improved argument documentation. [1] [2] [3] [4] [5] [6]Service
class inpy/selenium/webdriver/common/service.py
.🔧 Implementation Notes
💡 Additional Considerations
🔄 Types of changes
PR Type
Documentation
Description
Converted docstrings from
:param:
and:returns:
to Google-styleArgs
andReturns
formatUpdated multiple modules including CDP, script, driver finder, options, and service classes
Improved consistency and readability of parameter and return value documentation
Added type hints to method signatures in remote connection and script modules
Diagram Walkthrough
File Walkthrough
9 files
Convert CDP docstrings to Google-style format
Refactor script module docstrings to Args/Returns
Update DriverFinder class docstring format
Modernize options descriptor docstrings
Convert Service class docstrings to Google style
Update FirefoxProfile docstrings format
Refactor Firefox Service docstring format
Modernize RemoteConnection docstrings and add type hints
Update Safari Service docstring format